chore(ci): stop building old API docs on push#18016
Merged
Merged
Conversation
sfoster1
approved these changes
Apr 9, 2025
Member
sfoster1
left a comment
sfoster1
left a comment
There was a problem hiding this comment.
Looks good. I could have sworn we already did this though
Contributor
There was a problem hiding this comment.
Wait do we actually want to freeze the OT-2 hardware API docs like this? Weren't these supposed to be for internal users, and actually kept up to date?
If we're comfortable enough with freezing them, would we be comfortable enough to outright delete them?
Contributor
Author
There was a problem hiding this comment.
Happy to unfreeze them if that's the intended use case.
Contributor
Author
There was a problem hiding this comment.
It is safe to say though, that the technical content team is not modifying or maintaining them in any way.
Contributor
Author
There was a problem hiding this comment.
OK yeah, the autogenerated API ref (which isn't even linked from /hardware/index.html, but that's another matter) looks useful and pulls from recently updated code.
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice.
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 19, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 19, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 19, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 20, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 20, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 22, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 23, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 24, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 24, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 29, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 29, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
ddcc4
pushed a commit
that referenced
this pull request
May 29, 2025
# Overview Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.] Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules. ## Test Plan and Hands on Testing Spot check sandbox sites against current prod: - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/ot1/index.html - http://sandbox.docs.opentrons.com/infra-stop-building-old-docs/v1/index.html Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix. ## Changelog - new git ignore rules to track built copies of the archived docs sites - commit a copy of both sites - change `make -C api docs` to only build v2 and hardware docs. other sites can still be built, if needed, with other `make` commands. ## Review requests - **Is this the right way to go about this?** It works, but does it work how we want? - Is there anything in the Sphinx output that should still be ignored? I think not, but I'm not 100% - Double check built sites. - Also now is the time to speak up if you think any of these sites should go away forever 🚮 ## Risk assessment low-ish. you should basically never notice. (cherry picked from commit eb3aeb7)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Change build process so only the PAPI v2 docs get built on every push. [Update: also keeping hardware docs dynamic.]
Addresses RTC-711, although followup work may need to be done on AWS directly to add some robots.txt rules.
Test Plan and Hands on Testing
Spot check sandbox sites against current prod:
Everything should look the same. Not perfect, there is some formatting jankiness that I'm not attempting to fix.
Changelog
make -C api docsto only build v2 and hardware docs. other sites can still be built, if needed, with othermakecommands.Review requests
Risk assessment
low-ish. you should basically never notice.